/**
 * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package hr.web.jsf;

import java.util.ResourceBundle;

import javax.faces.application.FacesMessage;
import javax.faces.application.FacesMessage.Severity;
import javax.faces.context.FacesContext;

/**
 * <a href="FacesMessageUtil.java.html"><b><i>View Source</i></b></a>
 * 
 * @author Neil Griffin
 * 
 * This class provides static convenience methods for creating FacesMessage
 * objects from values in resource bundles, and adding them to the FacesContext
 * either globally, or to individual components only.
 * 
 */
public class FacesMessageUtil {

	public static void addComponentMessage(final String clientId,
			final FacesContext facesContext, final Severity severity,
			final String summary) {

		final FacesMessage facesMessage = new FacesMessage(severity, summary,
				null);
		facesContext.addMessage(clientId, facesMessage);
	}

	public static void addGlobalMessage(final FacesContext facesContext,
			final Severity severity, final String summary) {

		final FacesMessage facesMessage = new FacesMessage(severity, summary,
				null);
		facesContext.addMessage(null, facesMessage);
	}

	public static void addGlobalMessage(final FacesContext facesContext,
			final Severity severity, final String resourceBundleBaseName,
			final String key) {

		addGlobalMessage(facesContext, severity, resourceBundleBaseName, key,
				null);
	}

	public static void addGlobalMessage(final FacesContext facesContext,
			final Severity severity, final ResourceBundle resourceBundle,
			final String key) {

		addGlobalMessage(facesContext, severity, ResourceBundleUtil.getString(
				resourceBundle, facesContext.getExternalContext()
						.getRequestLocale(), key, null));
	}

	public static void addGlobalMessage(final FacesContext facesContext,
			final Severity severity, final String resourceBundleBaseName,
			final String key, final Object[] args) {

		final ResourceBundle resourceBundle = ResourceBundle.getBundle(
				resourceBundleBaseName, facesContext.getExternalContext()
						.getRequestLocale());
		addGlobalMessage(facesContext, severity, resourceBundle, key, args);
	}

	public static void addGlobalMessage(final FacesContext facesContext,
			final Severity severity, final ResourceBundle resourceBundle,
			final String key, final Object[] args) {

		addGlobalMessage(facesContext, severity, ResourceBundleUtil.getString(
				resourceBundle, facesContext.getExternalContext()
						.getRequestLocale(), key, args));
	}

	public static FacesMessage getFacesMessage(
			final String resourceBundleBaseName,
			final FacesContext facesContext, final Severity severity,
			final String key) {

		return (getFacesMessage(resourceBundleBaseName, facesContext, severity,
				key, null));
	}

	public static FacesMessage getFacesMessage(
			final ResourceBundle resourceBundle,
			final FacesContext facesContext, final Severity severity,
			final String key) {

		return (getFacesMessage(resourceBundle, facesContext, severity, key,
				null));
	}

	public static FacesMessage getFacesMessage(
			final String resourceBundleBaseName,
			final FacesContext facesContext, final Severity severity,
			final String key, final Object[] args) {

		final ResourceBundle resourceBundle = ResourceBundle.getBundle(
				resourceBundleBaseName, facesContext.getExternalContext()
						.getRequestLocale());

		return (getFacesMessage(resourceBundle, facesContext, severity, key,
				args));
	}

	public static FacesMessage getFacesMessage(
			final ResourceBundle resourceBundle,
			final FacesContext facesContext, final Severity severity,
			final String key, final Object[] args) {

		final String propertyValue = ResourceBundleUtil.getString(
				resourceBundle, facesContext.getExternalContext()
						.getRequestLocale(), key, args);

		return (new FacesMessage(severity, propertyValue, null));
	}

}
